Skip to content

docs(cli): make five help texts match the commands - #45

Merged
HaoZeke merged 1 commit into
mainfrom
fix/cli-help
Nov 16, 2026
Merged

HaoZeke merged 1 commit into
mainfrom
fix/cli-help

Conversation

@HaoZeke

@HaoZeke HaoZeke commented Nov 16, 2026

Copy link
Copy Markdown
Collaborator

Five --help texts now match what the commands do, including the stack admit example and exit status 78.

  • The top-level help now names exit status 78 from stack admit. The second stack admit example reads the quota and the scheduler inside --lock with --quota-cmd and --live-jobs-cmd, instead of expanding squeue before the lock. campaign --help shows campaign run. stack generation --help maps 2026.06 to 2026.1. stack batch --installed-modulerc says it reads a module tree as well as a .modulerc.lua file.

top_level_help_names_every_exit_status_the_reference_lists, stack_admit_help_examples_read_the_scheduler_inside_the_lock, campaign_help_shows_how_to_start_a_campaign, stack_generation_help_maps_every_bundled_eessi_version and every_installed_modulerc_help_says_a_module_tree_is_read cover those. The commit has a towncrier fragment. Main has no towncrier yet; #26 (fix/towncrier) adds it.

The second stack admit example piped mmlsquota-json into --quota-json -
and passed --live-jobs "$(squeue ... | paste -sd,)", so both were read
before any lock. The --live-jobs-cmd help, sharding-admission.org and
stack-shard.org all say that list can miss a job that reserved in
between. The example now takes --lock, --quota-cmd and --live-jobs-cmd,
and admits a job with stub commands for mmlsquota-json and squeue.

The top-level help listed exit status 0, 1 and 2; stack admit also
exits 78 when it refuses the job, as cli.org's table says. campaign
--help showed only the campaign status example, and not campaign run.
stack generation --help and the generation_lint module doc mapped
2023.06 and 2025.06 but not 2026.06, which the bundled table maps to
2026.1. stack batch --installed-modulerc said "Modulerc file", while
load_modulerc also scans a module tree, as the pr-overlap and
rebuild-set help say.

Five tests in cli_ergonomics.rs check these against cli.org, the
bundled table and every command that takes --installed-modulerc. They
fail without the fix. cli.org's stack batch text names both forms.
@HaoZeke
HaoZeke merged commit 8ad5f06 into main Nov 16, 2026
21 checks passed
@HaoZeke
HaoZeke deleted the fix/cli-help branch November 16, 2026 05:09
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant